<html>

<head>
<title>libvorbis - Return Codes</title>
<link rel=stylesheet href="style.css" type="text/css">
</head>

<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff">
<table border=0 width=100%>
<tr>
<td><p class=tiny>libvorbis documentation</p></td>
<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td>
</tr>
</table>

<h1>Return Codes</h1>

<p>

The following return codes are <tt>#define</tt>d in "vorbis/codec.h" and
may be returned by functions from libvorbis, <a
href="../vorbisfile/index.html">libvorbisfile</a>, and <a
href="../vorbisenc/index.html">libvorbisenc</a>.  Descriptions of a code
relevant to a specific function are found in the reference description
of that function.

<dl>

<dt>OV_FALSE</dt>
<dd>Not true, or no data available</dd>

<dt>OV_HOLE</dt>
<dd>Vorbisfile encoutered missing or corrupt data in the bitstream.  Recovery
is normally automatic and this return code is for informational purposes only.</dd>

<dt>OV_EREAD</dt>
<dd>Read error while fetching compressed data for decode</dd>

<dt>OV_EFAULT</dt>
<dd>Internal inconsistency in encode or decode state.  Continuing is likely not possible.</dd>

<dt>OV_EIMPL</dt>
<dd>Feature not implemented</dd>

<dt>OV_EINVAL</dt>
<dd>Either an invalid argument, or incompletely initialized argument passed to a call</dd>

<dt>OV_ENOTVORBIS</dt>
<dd>The given file/data was not recognized as Ogg Vorbis data.</dd>

<dt>OV_EBADHEADER</dt>
<dd>The file/data is apparently an Ogg Vorbis stream, but contains a corrupted or undecipherable header.</dd>

<dt>OV_EVERSION</dt>
<dd>The bitstream format revision of the given stream is not supported.</dd>

<dt>OV_EBADLINK</dt>
<dd>The given link exists in the Vorbis data stream, but is not decipherable due to garbacge or corruption.</dd>

<dt>OV_ENOSEEK</dt>
<dd>The given stream is not seekable</dd>

</dl>

<br><br>
<hr noshade>
<table border=0 width=100%>
<tr valign=top>
<td><p class=tiny>copyright &copy; 2000-2010 Xiph.Org</p></td>
<td align=right><p class=tiny><a href="https://xiph.org/vorbis/">Ogg Vorbis</a></p></td>
</tr><tr>
<td><p class=tiny>libvorbis documentation</p></td>
<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td>
</tr>
</table>

</body>

</html>
